Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Stop closed event propagating in automation editor elements #21424

Merged

Conversation

karwosts
Copy link
Contributor

@karwosts karwosts commented Jul 18, 2024

Proposed change

Several ha-button-menus throughout the automation editor were emitting a bubbling closed event, that was causing a parent dialog to be closed anytime a menu item was selected. Stop this event from propagating from these menus.

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New feature (thank you!)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Example configuration

Additional information

Checklist

  • The code change is tested and works locally.
  • There is no commented out code in this PR.
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

Summary by CodeRabbit

  • Bug Fixes
    • Improved event handling in automation panels by preventing unintended propagation when closing components. This change ensures smoother user interactions and prevents unexpected behaviors.

Copy link
Contributor

coderabbitai bot commented Jul 18, 2024

Walkthrough

Walkthrough

The recent changes introduce event handling enhancements across multiple automation-related components in the Home Assistant frontend. Specifically, the stopPropagation function is added to prevent the closing event from propagating undesirably, ensuring smoother user experience when modifying actions, conditions, or triggers within the automation editor. This addresses issues where the form would close unintentionally, such as when deleting an action or switching to YAML mode.

Changes

Files Change Summaries
src/panels/config/automation/action/ha-automation-action-row.ts Added stopPropagation import and event listener to handle closed event.
src/panels/config/automation/action/types/ha-automation-action-choose.ts Added stopPropagation import and event listener to handle closed event.
src/panels/config/automation/condition/ha-automation-condition-row.ts Added stopPropagation import and event listener to handle closed event.
src/panels/config/automation/trigger/ha-automation-trigger-row.ts Added stopPropagation import and event listener to handle closed event.
src/panels/config/automation/trigger/types/ha-automation-trigger-webhook.ts Added stopPropagation import and event listener to handle closed event in ha-button-menu component.

Assessment against linked issues

Objective (Issue #21413) Addressed Explanation
Prevent form closure when deleting an action.
Ensure the form remains open when switching the action editor to YAML mode.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@silamon silamon merged commit ee2b109 into home-assistant:dev Jul 18, 2024
14 checks passed
@karwosts karwosts deleted the automation-closed-stop-propagation branch July 18, 2024 22:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Action selector closing the template helper config flow
2 participants